Defining description, comment, JSON string or type for variables or data types
Syntax |
---|
|
Meaning | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
specification of the following pieces of additional data (= data elements) for a →variable, a →data type or a structure element (= language element):
The specification of the data elements is necessary in front of the concluding character The text for the description, comment and the JSON-string must be a character string literal within a →pragma. Examples for character string literals within pragmas Character string literals in pragmas consist of zero or more characters prefixed and terminated by the single quote character
You are able to directly enter special characters, such as umlauts or €, but Examples:
See the glossary article "→Character string literal" for more examples on these combinations and informative links. Moreover, the following specifications are possible for character string literals in pragmas:
Moreover, the following specifications are possible for character string literals in
If you need the character The data elements for the description, comment and JSON-string are typically evaluated by a system integrator. Within Neuron Power Engineer, description and comment of a variable are also visible within the interface editor. The data element for a concrete data type is only required in the case of the declaration of an →instance of a →vendor block, if this vendor block contains one or several inputs with a →generic data type and the declaration of the instance is done in a vendor block (so the vendor block with the |
The specification of the data elements is possible within these sections:
Example: Description, comment and JSON-string for a local variable |
---|
VAR
|
Example: Description and comment for a function block instance |
---|
|
Example: Description or comment for a structure element |
---|
|